Set Up Menu Component

To use the full capacity of the Menu Component, you must have the following items created and setup before customization:

  • Workspace and Maintenance Unit

  • Dashboard Group and Dashboard

  • Menu Component

  • Data Adapter

  • Data Set Service or Dashboard Data Set created through a Workspace Assembly or Business Rule

IMPORTANT: You can create and set up the following items in any order. You do not need to follow this order.

NOTE: You can also use a Parameter if it is part of your implementation.

Create a Menu Component

  1. On the Application tab, under Presentation, click Workspaces.

  2. Create a Workspace and Maintenance Unit, or select an existing one. If you are selecting an existing Workspaces, ensure it is a Default Workspace > Non-Default Maintenance Unit or any Non-Default Workspace > Maintenance Unit. See Create a Workspace.

  3. Create a Dashboard Group and Dashboard, or select an existing one. See Dashboard.

  4. Navigate to and select the Components node, and click the Create Dashboard Component toolbar button.

  5. In the Create Dashboard Component dialog box, click Menu, then OK.

  6. Name the Menu component.

  7. Click the Save button to save the changes.

Create a Data Adapter and Parameter

  1. In the Maintenance Unit, navigate to and select the Data Adapters node, and click the Create Data Adapter toolbar button.

  2. Name the Data Adapter.

  3. Click the Savebutton to save the changes.

  4. (Optional) Then, create a Parameter. See Create a Parameter.

    NOTE: Parameters are not a necessity, but can be used in certain Command Type queries.

  5. (Optional) After creating a Parameter, utilize it as needed within the Data Adapter's Data Source properties.

Create a Workspace Assembly

  1. In the Maintenance Unit, navigate to and select the Assemblies node, and click the Create Assembly toolbar button.

  2. Create an Assembly. When naming the Assembly, ensure naming conventions match with what is present in the Workspace or Maintenance Unit's Workspace Assembly Service field.

    Example: If the Workspace contains an Assembly named "MenuAssembly", you will need to specify "MenuAssembly.WsasFactory" in the Workspace Assembly Service field.

  3. Create an Assembly file using the Service Factory source code type.

    NOTE: You will choose the Service Factory and Data Set Service source code types to create two different Assembly files to use with the Menu Component.

    1. Create a new Assembly File for your Menu Component. In the Assemblies Files, right-click on Files and select Add File.

      In the Add File dialog box:

      1. Type WsasFactory as the File Name.

      2. Set your Source Code Type to Service Factory.

      3. Set your Compiler Action to (Use Default).

      4. Select OK.

  4. Create the second Assembly File. In the Assemblies Files, right-click on Files and select Add File.

    1. In the Add File dialog box:

      1. Type WsasDataSet as the File Name.

      2. Set your Source Code Type to Data Set Service.

      3. Set your Compiler Action to (Use Default).

      4. Select OK.

  5. Select the WsasFactory.cs (Service Factory) Assembly File and uncomment the lines of code that reference the previously created WsasDataSet - Data Set Service Assembly File.

    IMPORTANT: The Service Factory - Assembly File must contain uncommented code to function successfully: case WsAssemblyServiceType.DataSet:return new WsasDataSet();

  6. Select the WsasDataSet.cs (Data Set) Assembly File, and begin to customize and build out your Menu Component. See Customization and Menu Component and Items.

  7. Click the Save toolbar button to save the changes.

  8. Click the Compile Assembly to check syntax button to ensure the Workspace Assembly files compile successfully.